simetrix.script.commands

Implementation of All Script Commands

Provides implementations of all SIMetrix Script commands.

In the following table, the description (right column) is a link to the main SIMetrix documentation for the given command.

All commands take an optional command string which can be used to specify the arguments and options to the command. For example the NewSchem() command has an optional switch allowing to specify the initial simulator selection. To call NewSchem to specify SIMPLIS as the initial simulator, use

NewSchem("/simulator SIMPLIS")

Functions

Abort([command])

Abort

AbortSIMPLIS([command])

AbortSIMPLIS

About([command])

About

AddAnnotationText([command])

AddAnnotationText

AddArc([command])

AddArc

AddCirc([command])

AddCirc

AddCurveData([command])

AddCurveData

AddCurveMarker([command])

AddCurveMarker

AddDoubleClickAction([command])

AddDoubleClickAction

AddFileViewMenuItem([command])

AddFileViewMenuItem

AddFloodFill([command])

AddFloodFill

AddFreeText([command])

AddFreeText

AddGlobalStyle([command])

AddGlobalStyle

AddImage([command])

AddImage

AddImageScript([command])

AddImageScript

AddLegend([command])

AddLegend

AddLegendProp([command])

AddLegendProp

AddPin([command])

AddPin

AddProp([command])

AddProp

AddProperty([command])

AddProperty

AddSeg([command])

AddSeg

AddSymbolProperty([command])

AddSymbolProperty

AddTextBox([command])

AddTextBox

AddTitleBlock([command])

AddTitleBlock

AlignText([command])

AlignText

Anno([command])

Anno

AppendGroup([command])

AppendGroup

AppendTextWindow([command])

AppendTextWindow

Arguments([command])

Arguments

Cancel([command])

Cancel

CaptureWaveformImage([command])

CaptureWaveformImage

Cd([command])

Cd

ChangeArcAttributes([command])

ChangeArcAttributes

ChangeSelectedStyleNames([command])

ChangeSelectedStyleNames

ChangeStyle([command])

ChangeStyle

ChangeSymbolProperty([command])

ChangeSymbolProperty

ClearMessageWindow([command])

ClearMessageWindow

Close([command])

Close

CloseGraphSheet([command])

CloseGraphSheet

CloseLinkedRun([command])

CloseLinkedRun

ClosePrinter([command])

ClosePrinter

CloseSchem([command])

CloseSchem

CloseSheet([command])

CloseSheet

CloseSimplisStatusBox([command])

CloseSimplisStatusBox

CloseTextEditor([command])

CloseTextEditor

CollectGarbage([command])

CollectGarbage

CombineMenu([command])

CombineMenu

CompareSymbolLibs([command])

CompareSymbolLibs

ConvertBinaryGraph([command])

ConvertBinaryGraph

Copy([command])

Copy

CopyClipGraph([command])

CopyClipGraph

CopyClipSchem([command])

CopyClipSchem

CopyFile([command])

CopyFile

CopyLocalSymbol([command])

CopyLocalSymbol

CreateGroup([command])

CreateGroup

CreateRunningDialog([command])

CreateRunningDialog

CreateSym([command])

CreateSym

CreateToolBar([command])

CreateToolBar

CreateToolButton([command])

CreateToolButton

CursorMode([command])

CursorMode

Curve([command])

Curve

CurveEditCopy([command])

CurveEditCopy

DefButton([command])

DefButton

DefKey([command])

DefKey

DefMenu([command])

DefMenu

DefineToolBar([command])

DefineToolBar

Del([command])

Del

DelCrv([command])

DelCrv

DelGroup([command])

DelGroup

DelLegendProp([command])

DelLegendProp

DelMenu([command])

DelMenu

DelProp([command])

DelProp

DelSym([command])

DelSym

Delete([command])

Delete

DeleteAxis([command])

DeleteAxis

DeleteGlobalStyle([command])

DeleteGlobalStyle

DeleteGraphAnno([command])

DeleteGraphAnno

DeleteGraphObject([command])

DeleteGraphObject

DeleteShortWires([command])

DeleteShortWires

DeleteSymbolProperty([command])

DeleteSymbolProperty

DeleteToolBar([command])

DeleteToolBar

DestroyRunningDialog([command])

DestroyRunningDialog

Detach([command])

Detach

Discard([command])

Discard

Display([command])

Display

DrawArc([command])

DrawArc

DrawArrow([command])

DrawArrow

DrawPin([command])

DrawPin

Echo([command])

Echo

EditColour([command])

EditColour

EditCopy([command])

EditCopy

EditCut([command])

EditCut

EditFile([command])

EditFile

EditFont([command])

EditFont

EditGroupTitle([command])

EditGroupTitle

EditPaste([command])

EditPaste

EditPin([command])

EditPin

EndAllInteractions([command])

EndAllInteractions

EndSym([command])

EndSym

Execute([command])

Execute

FileViewCleanUpFileWatchers([command])

FileViewCleanUpFileWatchers

FloodFillSymbol([command])

FloodFillSymbol

Focus([command])

Focus

FocusCommandShell([command])

FocusCommandShell

FocusShell([command])

FocusShell

GroupSelected([command])

GroupSelected

Help([command])

Help

HideCurve([command])

HideCurve

HighlightCurve([command])

HighlightCurve

HighlightWidget([command])

HighlightWidget

Hint([command])

Hint

HourGlass([command])

HourGlass

ImportSymbol([command])

ImportSymbol

Inst([command])

Inst

KeepGroup([command])

KeepGroup

Let([command])

Let

ListModels([command])

ListModels

ListOptions([command])

ListOptions

Listing([command])

Listing

LoadModelIndex([command])

LoadModelIndex

LoadSimulatorStyleSheet([command])

LoadSimulatorStyleSheet

LoadStyleSheet([command])

LoadStyleSheet

LocalDeclAll([command])

LocalDeclAll

MCD([command])

MCD

MD([command])

MD

MakeAlias([command])

MakeAlias

MakeCatalog([command])

MakeCatalog

MakeSymbolScript([command])

MakeSymbolScript

MakeTree([command])

MakeTree

Message([command])

Message

MessageBox([command])

MessageBox

Move([command])

Move

MoveCurve([command])

MoveCurve

MoveFile([command])

MoveFile

MoveMenu([command])

MoveMenu

MoveProperty([command])

MoveProperty

Netlist([command])

Netlist

NewAnnotation([command])

NewAnnotation

NewAxis([command])

NewAxis

NewBasicTextEditor([command])

NewBasicTextEditor

NewFileView([command])

NewFileView

NewGraphWindow([command])

NewGraphWindow

NewGrid([command])

NewGrid

NewLabel([command])

NewLabel

NewLogicDefinitionEditor([command])

NewLogicDefinitionEditor

NewNetlist([command])

NewNetlist

NewPartSelector([command])

NewPartSelector

NewPlot([command])

NewPlot

NewPrinterPage([command])

NewPrinterPage

NewPythonFile([command])

NewPythonFile

NewSchem([command])

NewSchem

NewScript([command])

NewScript

NewStyle([command])

NewStyle

NewSymbol([command])

NewSymbol

NewVerilogA([command])

NewVerilogA

NewVerilogHDL([command])

NewVerilogHDL

NoPaint([command])

NoPaint

NoUndo([command])

NoUndo

OpenAsciiFile([command])

OpenAsciiFile

OpenBasicTextEditor([command])

OpenBasicTextEditor

OpenDirectory([command])

OpenDirectory

OpenExternalFile([command])

OpenExternalFile

OpenGraph([command])

OpenGraph

OpenGroup([command])

OpenGroup

OpenLinkedRun([command])

OpenLinkedRun

OpenLogicDefinitionEditor([command])

OpenLogicDefinitionEditor

OpenNetlist([command])

OpenNetlist

OpenPrinter([command])

OpenPrinter

OpenPythonFile([command])

OpenPythonFile

OpenRawFile([command])

OpenRawFile

OpenSchem([command])

OpenSchem

OpenScript([command])

OpenScript

OpenSimplisStatusBox([command])

OpenSimplisStatusBox

OpenVerilogA([command])

OpenVerilogA

OpenVerilogHDL([command])

OpenVerilogHDL

OpenWebPage([command])

OpenWebPage

OptimiserCreate([command])

OptimiserCreate

OptimiserRequestFinish([command])

OptimiserRequestFinish

OptionsDialog([command])

OptionsDialog

Pan([command])

Pan

PasteGraphImageToSchematic([command])

PasteGraphImageToSchematic

Pause([command])

Pause

PlaceCursor([command])

PlaceCursor

Plot([command])

Plot

PreProcessNetlist([command])

PreProcessNetlist

PrintGraph([command])

PrintGraph

PrintSchematic([command])

PrintSchematic

Probe([command])

Probe

Prop([command])

Prop

Protect([command])

Protect

Quit([command])

Quit

RD([command])

RD

ReadLogicCompatibility([command])

ReadLogicCompatibility

RebuildSymbols([command])

RebuildSymbols

Redirect([command])

Redirect

RedirectMessages([command])

RedirectMessages

Redo([command])

Redo

RedrawGraph([command])

RedrawGraph

RegisterUserFunction([command])

RegisterUserFunction

RenameLibs([command])

RenameLibs

RenameMenu([command])

RenameMenu

RepeatLastMenu([command])

RepeatLastMenu

ReplayTraces([command])

ReplayTraces

Reset([command])

Reset

ResizeWindow([command])

ResizeWindow

RestoreCommandShell([command])

RestoreCommandShell

RestoreDefaultStyles([command])

RestoreDefaultStyles

Resume([command])

Resume

RotInst([command])

RotInst

Run([command])

Run

RunAsync([command])

RunAsync

RunCurrentScript([command])

RunCurrentScript

RunSIMPLIS([command])

RunSIMPLIS

Save([command])

Save

SaveAs([command])

SaveAs

SaveGraph([command])

SaveGraph

SaveGroup([command])

SaveGroup

SaveRhs([command])

SaveRhs

SaveSnapShot([command])

SaveSnapShot

SaveSymbol([command])

SaveSymbol

SaveSymlib([command])

SaveSymlib

SaveTextEditor([command])

SaveTextEditor

SaveTextEditorAs([command])

SaveTextEditorAs

SchematicEnableFileWatcher([command])

SchematicEnableFileWatcher

SchematicFileWatcherIgnoreChanges([command])

SchematicFileWatcherIgnoreChanges

SchematicFileWatcherWatchChanges([command])

SchematicFileWatcherWatchChanges

ScreenShotWindow([command])

ScreenShotWindow

ScriptAbort([command])

ScriptAbort

ScriptPause([command])

ScriptPause

ScriptResume([command])

ScriptResume

ScriptStep([command])

ScriptStep

Select([command])

Select

SelectCurve([command])

SelectCurve

SelectGraph([command])

SelectGraph

SelectLegends([command])

SelectLegends

SelectSchematic([command])

SelectSchematic

SelectSimulator([command])

SelectSimulator

SelectSymbolPin([command])

SelectSymbolPin

SelectSystemWidget([command])

SelectSystemWidget

SelectWireConnected([command])

SelectWireConnected

Set([command])

Set

SetAnnotationTextPosition([command])

SetAnnotationTextPosition

SetCurveName([command])

SetCurveName

SetDefaultEncoding([command])

SetDefaultEncoding

SetDisable([command])

SetDisable

SetGraphAnnoProperty([command])

SetGraphAnnoProperty

SetGroup([command])

SetGroup

SetHighlight([command])

SetHighlight

SetOrigin([command])

SetOrigin

SetPinPrefix([command])

SetPinPrefix

SetPinSuffix([command])

SetPinSuffix

SetReadOnly([command])

SetReadOnly

SetRef([command])

SetRef

SetSnapGrid([command])

SetSnapGrid

SetStyleColour([command])

SetStyleColour

SetSymbolFillStyle([command])

SetSymbolFillStyle

SetSymbolOriginVisibility([command])

SetSymbolOriginVisibility

SetUnits([command])

SetUnits

Shell([command])

Shell

ShellOld([command])

ShellOld

Show([command])

Show

ShowCurve([command])

ShowCurve

ShowSimulatorWindow([command])

ShowSimulatorWindow

SizeGraph([command])

SizeGraph

SwitchModelSection([command])

SwitchModelSection

TemplateEditProperty([command])

TemplateEditProperty

TemplateSetValue([command])

TemplateSetValue

TextEditorCommentLines([command])

TextEditorCommentLines

TextEditorFileWatcherIgnoreChanges([command])

TextEditorFileWatcherIgnoreChanges

TextEditorFileWatcherWatchChanges([command])

TextEditorFileWatcherWatchChanges

TextEditorFind([command])

TextEditorFind

TextEditorFindNext([command])

TextEditorFindNext

TextEditorGoToLine([command])

TextEditorGoToLine

TextEditorUncommentLines([command])

TextEditorUncommentLines

TextWin([command])

TextWin

Title([command])

Title

TitleSchem([command])

TitleSchem

Trace([command])

Trace

UnHighlightCurves([command])

UnHighlightCurves

UnLet([command])

UnLet

UnSet([command])

UnSet

Undo([command])

Undo

UndoGraphZoom([command])

UndoGraphZoom

UngroupSelected([command])

UngroupSelected

Unprotect([command])

Unprotect

Unselect([command])

Unselect

Unzip([command])

Unzip

UpdateAllSymbols([command])

UpdateAllSymbols

UpdateAnnotationText([command])

UpdateAnnotationText

UpdateDefaultStyle([command])

UpdateDefaultStyle

UpdateGlobalStyle([command])

UpdateGlobalStyle

UpdateGraphColours([command])

UpdateGraphColours

UpdateProperties([command])

UpdateProperties

UpdateRunningDialog([command])

UpdateRunningDialog

UpdateStyleInfo([command])

UpdateStyleInfo

UpdateSymbol([command])

UpdateSymbol

UpdateSystemStyleInfo([command])

UpdateSystemStyleInfo

UpdateTitleBlock([command])

UpdateTitleBlock

UseGlobalStyles([command])

UseGlobalStyles

ViewFile([command])

ViewFile

WM_CloseAllSystemWidgets([command])

WM_CloseAllSystemWidgets

WM_CloseNonPrimaryWindows([command])

WM_CloseNonPrimaryWindows

WM_CloseSheet([command])

WM_CloseSheet

WM_ProgressWindowClose([command])

WM_ProgressWindowClose

WM_ProgressWindowCloseAll([command])

WM_ProgressWindowCloseAll

WM_ProgressWindowCreate([command])

WM_ProgressWindowCreate

WM_ProgressWindowReport([command])

WM_ProgressWindowReport

WM_RevertToSaved([command])

WM_RevertToSaved

WM_Undock([command])

WM_Undock

WebOpen([command])

WebOpen

Wire([command])

Wire

WireMode([command])

WireMode

WriteImportedModels([command])

WriteImportedModels

XMLAddAttribute([command])

XMLAddAttribute

XMLAddElement([command])

XMLAddElement

XMLClose([command])

XMLClose

XMLGoUpLevel([command])

XMLGoUpLevel

XMLNew([command])

XMLNew

XMLOpenElement([command])

XMLOpenElement

XMLOpenFile([command])

XMLOpenFile

XMLSaveFile([command])

XMLSaveFile

Zip([command])

Zip

Zoom([command])

Zoom